<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: PolygonMarker</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Class: PolygonMarker</h1>

    




<section>

<header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>
            <span class="ancestors"><a href="global.html#ROS2D">ROS2D</a>.</span>PolygonMarker<span class="signature">(options)</span><span class="type-signature"></span></h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        

    

    
    <h4 class="name" id="PolygonMarker"><span class="type-signature"></span>new PolygonMarker<span class="signature">(options)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    A polygon that can be edited by an end user
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last">object with following keys:
  * pose (optional) - the first pose of the trace
  * lineSize (optional) - the width of the lines
  * lineColor (optional) - the createjs color of the lines
  * pointSize (optional) - the size of the points
  * pointColor (optional) - the createjs color of the points
  * fillColor (optional) - the createjs color to fill the polygon
  * lineCallBack (optional) - callback function for mouse interaction with a line
  * pointCallBack (optional) - callback function for mouse interaction with a point</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="models_PolygonShape.js.html">models/PolygonShape.js</a>, <a href="models_PolygonShape.js.html#line19">line 19</a>
    </li></ul></dd>
    

    

    

    
</dl>


















    
    </div>

    

    

    

    

    

    

    

    
        <h3 class="subsection-title">Methods</h3>

        
            

    

    
    <h4 class="name" id="addPoint"><span class="type-signature"></span>addPoint<span class="signature">(position)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    Adds a point to the polygon
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>position</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last">of type ROSLIB.Vector3</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="models_PolygonShape.js.html">models/PolygonShape.js</a>, <a href="models_PolygonShape.js.html#line105">line 105</a>
    </li></ul></dd>
    

    

    

    
</dl>


















        
            

    

    
    <h4 class="name" id="createLineShape"><span class="type-signature"></span>createLineShape<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    Internal use only
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="models_PolygonShape.js.html">models/PolygonShape.js</a>, <a href="models_PolygonShape.js.html#line51">line 51</a>
    </li></ul></dd>
    

    

    

    
</dl>


















        
            

    

    
    <h4 class="name" id="createPointShape"><span class="type-signature"></span>createPointShape<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    Internal use only
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="models_PolygonShape.js.html">models/PolygonShape.js</a>, <a href="models_PolygonShape.js.html#line83">line 83</a>
    </li></ul></dd>
    

    

    

    
</dl>


















        
            

    

    
    <h4 class="name" id="drawFill"><span class="type-signature"></span>drawFill<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    Internal use only
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="models_PolygonShape.js.html">models/PolygonShape.js</a>, <a href="models_PolygonShape.js.html#line262">line 262</a>
    </li></ul></dd>
    

    

    

    
</dl>


















        
            

    

    
    <h4 class="name" id="editLineShape"><span class="type-signature"></span>editLineShape<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    Internal use only
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="models_PolygonShape.js.html">models/PolygonShape.js</a>, <a href="models_PolygonShape.js.html#line72">line 72</a>
    </li></ul></dd>
    

    

    

    
</dl>


















        
            

    

    
    <h4 class="name" id="movePoint"><span class="type-signature"></span>movePoint<span class="signature">(obj, position)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    Moves a point of the polygon
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>obj</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last">either an index (integer) or a point shape of the polygon</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>position</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last">of type ROSLIB.Vector3</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="models_PolygonShape.js.html">models/PolygonShape.js</a>, <a href="models_PolygonShape.js.html#line191">line 191</a>
    </li></ul></dd>
    

    

    

    
</dl>


















        
            

    

    
    <h4 class="name" id="remPoint"><span class="type-signature"></span>remPoint<span class="signature">(obj)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    Removes a point from the polygon
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>obj</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last">either an index (integer) or a point shape of the polygon</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="models_PolygonShape.js.html">models/PolygonShape.js</a>, <a href="models_PolygonShape.js.html#line142">line 142</a>
    </li></ul></dd>
    

    

    

    
</dl>


















        
            

    

    
    <h4 class="name" id="splitLine"><span class="type-signature"></span>splitLine<span class="signature">(obj)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    Splits a line of the polygon: inserts a point at the center of the line
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>obj</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last">either an index (integer) or a line shape of the polygon</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="models_PolygonShape.js.html">models/PolygonShape.js</a>, <a href="models_PolygonShape.js.html#line224">line 224</a>
    </li></ul></dd>
    

    

    

    
</dl>


















        
    

    

    
</article>

</section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ROS2D.ArrowShape.html">ArrowShape</a></li><li><a href="ROS2D.Grid.html">Grid</a></li><li><a href="ROS2D.ImageMap.html">ImageMap</a></li><li><a href="ROS2D.ImageMapClient.html">ImageMapClient</a></li><li><a href="ROS2D.NavigationArrow.html">NavigationArrow</a></li><li><a href="ROS2D.NavigationImage.html">NavigationImage</a></li><li><a href="ROS2D.OccupancyGrid.html">OccupancyGrid</a></li><li><a href="ROS2D.OccupancyGridClient.html">OccupancyGridClient</a></li><li><a href="ROS2D.OccupancyGridSrvClient.html">OccupancyGridSrvClient</a></li><li><a href="ROS2D.PanView.html">PanView</a></li><li><a href="ROS2D.PathShape.html">PathShape</a></li><li><a href="ROS2D.PolygonMarker.html">PolygonMarker</a></li><li><a href="ROS2D.TraceShape.html">TraceShape</a></li><li><a href="ROS2D.Viewer.html">Viewer</a></li><li><a href="ROS2D.ZoomView.html">ZoomView</a></li></ul><h3>Global</h3><ul><li><a href="global.html#ROS2D">ROS2D</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 04 2018 06:50:47 GMT+0000 (UTC)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>